Interface SimFile

All Superinterfaces:
IPCObject
All Known Subinterfaces:
Directory, FileSystem
All Known Implementing Classes:
DirectoryImpl, FileSystemImpl, SimFileImpl

public interface SimFile extends IPCObject
Information provided by the PKI file:

    \class SimFile
    
    \brief SimFile holds and manipulates files on file systems.
    
    \example network().getDevice("Router0").getProcess("FileManager").getFileSystem("flash:").getFileAt(0)
    
Author:
Auto-generated
  • Method Details

    • getName

      String getName()
      Information provided by the PKI file:
      
          \brief Returns the filename of the file.
          
          \return string, the filename of the file.
          
              
      Returns:
      String Returns a String
    • getPermission

      FilePermission getPermission()
      Information provided by the PKI file:
      
          \brief Returns the permissions of the file.
          
          \return     FilePermission, the permissions of the file.
          Permissions:        eExecute = 1,
          eWrite = 2,
          eRead = 4
          
              
      Returns:
      FilePermission Returns a FilePermission
    • isExecutable

      boolean isExecutable()
      Information provided by the PKI file:
      
          \brief Returns true if the file is executable, otherwise false.
          
          \return bool, true if the file is executable, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isWritable

      boolean isWritable()
      Information provided by the PKI file:
      
          \brief Returns true if the file is writable, otherwise false.
          
          \return bool, true if the file is writable, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isReadable

      boolean isReadable()
      Information provided by the PKI file:
      
          \brief Returns true if the file is readable, otherwise false.
          
          \return bool, true if the file is readable, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isDirectory

      boolean isDirectory()
      Information provided by the PKI file:
      
          \brief Returns true if the file is a directory, otherwise false.
          
          \return bool, true if the file is a directory, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getSize

      int getSize()
      Information provided by the PKI file:
      
          \brief Returns the filesize of the file.
          
          \return int, the filesize of the file.
          
              
      Returns:
      int Returns a int
    • getParent

      Directory getParent()
      Information provided by the PKI file:
      
          \brief Returns the parent directory.
          
          \return Directory, the parent directory.
          
              
      Returns:
      Directory Returns a Directory
    • getAbsPath

      String getAbsPath()
      Information provided by the PKI file:
      
          \brief Returns absolute path of the SimFile object.
          
          \return string, absolute path of the SimFile object.
          
              
      Returns:
      String Returns a String
    • setTextContent

      void setTextContent(String content, boolean bCheckPermission)
      Information provided by the PKI file:
      
          \brief set the content of the SimFile object.
          
          \param content, the content string to set to the SimFile.
          \param bCheckPermission, true if check the permission of the file, otherwise false.
          
              
      Parameters:
      content - Takes in a parameter of content
      bCheckPermission - Takes in a parameter of bCheckPermission
    • getContent

      FileContent getContent(boolean bCheckPermission)
      Information provided by the PKI file:
      
          \brief Returns the file content of the SimFile.
          
          \param bCheckPermission, true if check the permission of the file, otherwise false.
          
          \return FileContent, the file content of the SimFile.
          
              
      Parameters:
      bCheckPermission - Takes in a parameter of bCheckPermission
      Returns:
      FileContent Returns a FileContent